Ordering Parameters

Purchase Request Parameters

The parameters in the following table are used in requests to purchase Adobe products.

Note:
- Refer to CloudBlue Commerce API documentation for additional information on how to manage orders through the platform's API.

Parameter ID	Required	Value / Description
action_type	Yes	Use one of the following strings: transfer: This string is used if the new order is a transfer from traditional. purchase: This string is used if the new order is a normal purchase.
adobe_user_email	No	Customer email to create the account in the Adobe system.
external_reference_id	No	Reference to the external system order_id.

Parameter ID

Required

Value / Description

action_type

Yes

Use one of the following strings:

transfer: This string is used if the new order is a transfer from traditional.
purchase: This string is used if the new order is a normal purchase.

adobe_user_email

Customer email to create the account in the Adobe system.

external_reference_id

Reference to the external system order_id.

Transfer Request Parameters

The parameters in the following table are used in requests to transfer Adobe products.

Parameter ID	Required	Description
adobe_vip_number	Only if the action_type is transfer	Use one of the following strings: transfer: This string is used if the new order is a transfer from traditional. purchase: This string is used if the new order is a normal purchase.

Parameter ID

Required

Description

adobe_vip_number

Only if the action_type is transfer

Use one of the following strings:

transfer: This string is used if the new order is a transfer from traditional.
purchase: This string is used if the new order is a normal purchase.

Customer and Company Information Parameters

The following parameters are only required when the customer details or the company information did not pass Adobe's validation.

Parameter ID	Required	Value / Description
customer_company_name	No	Company name
customer_address_line_1	No	Business address line
customer_address_line_2	No	Business address line
customer_postal_code	No	ZIP or Postal Code
customer_city	No	City of your business
customer_region	No	State/region two-letter code. For example, CA.
customer_country	No	Country two-letter code. For example, US.
customer_phone_number	No	Phone number

Parameters Used for Tier Configuration

In a distributor model (N-tier), the following parameters can be provided in the API requests.

Parameter ID	Required	Value / Description
reseller_company_name	No	Company name
reseller_postal_code	No	ZIP or Postal Code
reseller_city	No	City of your business
reseller_region	No	State/region two-letter code. For example, CA.
reseller_country	No	Country two-letter code. For example, US.
reseller_phone_number	No	Phone number

Changing the Auto-Renewal Flag of Subscriptions

Parameter ID	Required	Value / Description
set_auto_renewal_status	Only if the Auto-Renewal status needs to be changed.	Use one of the following values: active_auto_renewal_status: This will activate the auto-renewal for the corresponding subscription in Adobe. inactive_auto_renewal_status: This will deactivate the auto-renewal for the corresponding subscription in Adobe.

Parameter ID

Required

Value / Description

set_auto_renewal_status

Only if the Auto-Renewal status needs to be changed.

Use one of the following values:

active_auto_renewal_status: This will activate the auto-renewal for the corresponding subscription in Adobe.
inactive_auto_renewal_status: This will deactivate the auto-renewal for the corresponding subscription in Adobe.

Here's an example:

Copy

{
    "id": "cb_autorenewal",
    "value": "active_auto_renewal_status"
}

Model One-to-One Subscription

This model allows the creation of orders with only one product per subscription. In this way, the orders can only have one product. If we want to purchase several products, we need the next parameter to have the Adobe discounts.

Parameter ID	Required	Value / Description
transaction_id	Only for one-to-one model and we want to purchase several products.	GUID to identify the transaction.
transaction_items	Only for one-to-one model and we want to purchase several products.	Number of orders that belongs to the transaction.
business-model	Only for one-to-one model.	Allows the creation of assets with 1:1 support. Use one of the following values: one-to-many: Use this for the One-to-Many business model. This is the default value. one-to-one: Use this for the One-to-One business model.

Parameter ID

Required

Value / Description

transaction_id

Only for one-to-one model and we want to purchase several products.

GUID to identify the transaction.

transaction_items

Only for one-to-one model and we want to purchase several products.

Number of orders that belongs to the transaction.

business-model

Only for one-to-one model.

Allows the creation of assets with 1:1 support.

Use one of the following values:

one-to-many: Use this for the One-to-Many business model. This is the default value.
one-to-one: Use this for the One-to-One business model.

Change and Cancellation Process

We have a period of 14 days to make the cancellation in Adobe and get the refund for an order. To allow this process, we need to indicate that the downsize is a cancel order and provide the order ID that we want to cancel.

Parameter ID	Required	Value / Description
is_cancellation_order	Only for downsizes that are cancellations for any order.	Use one of the following values: is-cancellation-request no-cancellation-request
cancel_order_id	Only for downsizes that are cancellations for any order.	Adobe order ID to cancel.

Parameter ID

Required

Value / Description

is_cancellation_order

Only for downsizes that are cancellations for any order.

Use one of the following values:

is-cancellation-request
no-cancellation-request

cancel_order_id

Only for downsizes that are cancellations for any order.

Adobe order ID to cancel.

Migration Orders in Seamless-Move

To create migration orders in seamless-move, see instructions on the Manage Orders page of the Simple API guide.